package cool.lichuan.zabbix.constant;

/**
 * @author LiChuan
 * @date 2021/11/8 9:29
 */
public interface CommonField {
    /** 请求返回错误数据，此字段有值代表请求返回错误信息 */
    String RESP_ERROR = "error";
    /** 请求返回的数据信息 */
    String RESP_RESULT  ="result";
    /** 请求唯一标识 */
    String RESP_ID = "id";
    /** API 使用的JSON-RPC协议的版本 当前为2.0 */
    String RESP_JSON_RPC = "jsonrpc";

    /** -------------  公共请求参数  ------------- */
    /** 返回结果中的记录数而不是实际数据, 如使用则返回获取的对象数量.(boolean) */
    String PARAM_COUNT_OUTPUT = "countOutput";
    /** 如果设置为true仅返回用户具有写入权限的对象, 默认false(boolean) */
    String PARAM_EDITABLE = "editable";
    /** 返回与search参数中给出的条件不匹配的结果(boolean) */
    String PARAM_EXCLUDE_SEARCH = "excludeSearch";
    /** 仅返回与给定过滤器完全匹配的那些结果。
     接受一个数组，其中键是属性名称，值是要匹配的单个值或值数组。
     不适用于text字段。(object)  使用方式： 参数 ==> "filter": {"host": ["xxx", "xxx"]} */
    String PARAM_FILTER = "filter";
    /** 返回与search参数中给出的条件不匹配的结果(integer) */
    String PARAM_LIMIT = "limit";
    /** 相当于条件查询，限定输出字段，取值：空或者extend查全部，字段集合可查询部分字段(query) */
    String PARAM_OUT_PUT = "output";
    /** 返回与search参数中给出的条件不匹配的结果(boolean) */
    String PARAM_PRESERVE_KEYS = "preservekeys";
    /** 返回与search参数中给出的条件不匹配的结果(object) */
    String PARAM_SEARCH = "search";
    /** 返回与search参数中给出的条件不匹配的结果(boolean) */
    String PARAM_SEARCH_BY_ANY = "searchByAny";
    /** 返回与search参数中给出的条件不匹配的结果(boolean) */
    String PARAM_SEARCH_WILDCARDS_ENABLED = "searchWildcardsEnabled";
    /** 返回与search参数中给出的条件不匹配的结果(string/array) */
    String PARAM_SORT_FIELD = "sortfield";
    /** 返回与search参数中给出的条件不匹配的结果(string/array) */
    String PARAM_SORT_ORDER = "sortorder";
    /** 返回与search参数中给出的条件不匹配的结果(boolean) */
    String PARAM_START_SEARCH = "startSearch";

    /** 主机接口查询字段 */
    String PARAM_SELECT_INTERFACES = "selectInterfaces";
}
